package com.zy.explore.order.interfaces.feign;

import com.zy.explore.common.interfaces.frm.CommonIdsFrm;
import com.zy.explore.order.infrastructure.constant.ProjectConstant;
import com.zy.explore.order.interfaces.frm.OrderFrm;
import com.zy.explore.order.interfaces.vo.OrderVO;

import com.zy.explore.common.interfaces.vo.PageVO;
import com.zy.explore.common.interfaces.frm.CommonIdFrm;

import io.swagger.annotations.ApiOperation;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;

import java.util.List;

/**
 * (表t_order)Feign服务
 *
 * 由于service-module-order服务的接口访问基路径为 context-path=/order
 * UserFacade的类路径为 /order
 * 所以对应的Feign的基路径为 /order/order
 *
 * @author 中国印
 * @date 2021-09-20 20:17:30
 */
@FeignClient(value = ProjectConstant.SERVICE_NAME, path = "/order/order", contextId = ProjectConstant.SERVICE_NAME + ".order")
public interface OrderFeign {

    /**
     * 新增数据
     *
     * @param frm 待新增的frm对象
     * @return 成功返回新增后的VO对象，失败返回null
     */
    @ApiOperation("新增数据")
    @PostMapping("/insert")
    OrderVO insert(@RequestBody @Validated OrderFrm frm);

    /**
     * 删除数据
     *
     * @param frm 主键frm对象
     * @return 1:删除成功 其他:删除失败
     */
    @ApiOperation("删除数据")
    @PostMapping("/delete")
    Integer delete(@RequestBody @Validated CommonIdFrm frm);

    /**
     * 更新数据
     *
     * @param frm 待更新的frm对象
     * @return 成功返回更新后的VO对象，失败返回null
     */
    @ApiOperation("更新数据")
    @PostMapping("/update")
    OrderVO update(@RequestBody @Validated OrderFrm frm);

    /**
     * 通过主键查询单条数据
     *
     * @param frm 主键Frm对象
     * @return 成功返回对应ID的VO对象，失败返回null
     */
    @ApiOperation("根据主键查询数据")
    @PostMapping("/findById")
    OrderVO findById(@RequestBody @Validated CommonIdFrm frm);

    /**
     * 通过主键批量查询数据集合
     *
     * @param frm 主键集合Frm对象
     * @return 成功返回对应ID的VO对象，失败返回空集合
     */
    @ApiOperation("根据主键集批量查询数据")
    @PostMapping("/findByIds")
    List<OrderVO> findByIds(@RequestBody @Validated CommonIdsFrm frm);

    /**
     * 根据条件获取数据集
     *
     * @param frm 查询条件对象
     * @return 成功返回满足条件的数据集合，失败返回空集合
     */
    @ApiOperation("根据条件查询数据集")
    @PostMapping("/getList")
    List<OrderVO> getList(@RequestBody @Validated OrderFrm frm);

    /**
     * 根据条件查询数据分页
     *
     * @param frm 查询条件参数
     * @return 成功返回满足条件的分页，失败返回空页
     */
    @ApiOperation("根据条件查询数据分页")
    @PostMapping("/getPageInfo")
    PageVO<OrderVO> getPageInfo(@RequestBody @Validated OrderFrm frm);

}
